Skip to content

Extra Profile Properties#12

Open
FeLungs wants to merge 2 commits intomasterfrom
extra_props
Open

Extra Profile Properties#12
FeLungs wants to merge 2 commits intomasterfrom
extra_props

Conversation

@FeLungs
Copy link
Copy Markdown
Owner

@FeLungs FeLungs commented Jan 9, 2023

Addresses: #3

  • Update section 4.0 to disallow properties not defined in this document (JSON-LD keywords still allowed)
  • Update Profile Server section to include initial requirements related to Profile ingestion and storage

@FeLungs FeLungs added this to the IEEE language milestone Jan 9, 2023
Comment on lines +59 to +62
When storing an xAPI Profile:
* a Profile Server MUST NOT add any properties (not defined in this document) to the Profile
* a Profile Server MAY add JSON-LD keywords (or aliases thereof) to a Profile anywhere they are legal in JSON-LD
* a Profile Server MUST reject any Profiles that contain any properties not defined in this document (excluding correctly used JSON-LD keywords or aliases thereof)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't we use SHALL and SHALL NOT to align with IEEE style ?

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Profile Server Version handling, what are the requirements for releasing a new version. Does the author of the profile manage / maintain the profile versions or is that solely a responsibility of the profile server.

-> Initial thoughts, profile server shouldn't be the only place that handles versioning, authors should be expected to include the version info in their profiles so that the version information is not lost on upload to a profile server.

-> Profile server may offer publish mechanics which applies publishes changes to a profile as a new version

There should / will be a Profile Server subgroup that gets into the details of what the Profile Server requirements are. The requirements added here were in relation to the additional properties requirement change.

* All properties that are not JSON-LD keywords (or aliases thereof) MUST expand to absolute IRIs during processing as defined in the JSON-LD specification.
* All properties that are not JSON-LD keywords (or aliases thereof) and not described by this specification MUST be expressed using compact IRIs or absolute IRIs.
* JSON-LD keywords (or aliases thereof) that are not specified as properties in this document MAY be included anywhere they are legal in JSON-LD.
* A Profile MUST only include properties defined in this document and JSON-LD keywords (or aliases thereof).
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as previous comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants